#!/bin/bash
#
# TODO: Put a proper description here, update author information, add a
# copyright notice to the existing notice.
# TODO: Find all instances of MYAGENT and replace with your agent name
# TODO: Document your code!
#
# Author:   Dr. Mike Murphy (mmurphy2@coastal.edu)
# Revision: 12 November 2012
#
#   Copyright 2012-2013 Coastal Carolina University
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#


## p_agent_MYAGENT_help
##
## Echoes help information for the MYAGENT agent. Returns 0.
##
function p_agent_MYAGENT_help() {
	cat << EOF
This agent drags the author out into the street and shoots him or her for
failing to write documentation.
EOF
	return 0
}


## p_agent_MYAGENT_summary
##
## Echoes summary information for the MYAGENT agent. Returns 0.
##
function p_agent_MYAGENT_summary() {
	echo "Shoots the author for failing to write documentation"
	return 0
}


## p_agent_MYAGENT_check
##
## Implements the logic to check to see if the agent needs to perform any
## tasks, without actually performing the task. Returns 0 if no tasks need
## to be performed, 100 if there is work to do.
##
function p_agent_MYAGENT_check() {
	return 0
}


## p_agent_MYAGENT_run
##
## Runs the MYAGENT agent. Returns 0 on success, non-zero if an error occurs.
##
function p_agent_MYAGENT_run() {
	echo "Hello, World!"
	return 0
}
